package com.ecommerce.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * Swagger API文档配置类
 * <p>
 * 配置Swagger2用于自动生成RESTful API文档
 * 通过注解自动扫描控制器类并生成接口文档
 *
 * @see springfox.documentation.spring.web.plugins.Docket
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    /**
     * 配置Swagger Docket实例
     * <p>
     * 创建并返回一个Docket实例，用于定义API文档的生成规则
     *
     * @return 配置好的Docket实例
     *
     * @apiNote 当前配置：
     *          1. 使用SWAGGER_2文档类型
     *          2. 扫描com.ecommerce.controller包下的所有控制器
     *          3. 包含所有路径的API
     */
    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.ecommerce.controller"))
                .paths(PathSelectors.any())
                .build();
    }
}